home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 015a / flix110.zip / FLIX.HLP < prev    next >
Text File  |  1991-07-20  |  22KB  |  787 lines
  1. .**********************************************************************
  2. .*  FLIX help file.                                                   *
  3. .*                                                                    *
  4. .*  Dot commands:                                                     *
  5. .*                                                                    *
  6. .*    .* Comment. Will not appear on screen.                          *
  7. .*    .t The title. 1-8 Character Title.                              *
  8. .*    .r Other references. Total of 9, 1 - 8 Characters each.         *
  9. .*    .x Start and end of text description for this title.            *
  10. .*                                                                    *
  11. .*--------------------------------------------------------------------*
  12. .t (c)1991
  13. .x
  14.  
  15.    FLIX Version 1.10
  16.  
  17.    The program and help text are (c) Copyright 1990, 1991 by:
  18.  
  19.           HK Square Inc.
  20.           24-16 Steinway Street, Suite 580.
  21.           L.I.C., NY 11103
  22.           (718) 728-5077
  23.  
  24.    Portions of the help text are
  25.    (c) Copyright 1985, 1986, 1987 by Codecrafters.
  26.  
  27.    This program is dedicated to all our Beta Testers for their help
  28.    in producing FLIX and the FLIX help system.
  29.  
  30.    Thanks guys !
  31. .x
  32.  
  33. .**********************************************************************
  34. .t FLIX=
  35. .r Syntax
  36. .x
  37.  
  38.  FLIX Environment variable settings
  39.  
  40.  A user can set the DOS Environment variable FLIX to contain the
  41.  correct path to the FLIX.HLP and FLIX.PRO files.
  42.  
  43.  Please note that any FLIX.HLP and FLIX.PRO found in the current
  44.  directory will always be used first.
  45.  
  46.  Example:
  47.  
  48.    SET FLIX=C:\FLIX\
  49.  
  50.  The ending backslash is not required.
  51. .x
  52.  
  53. .**********************************************************************
  54. .t Syntax
  55. .r Commands Keys Profile Screen
  56. .x
  57.  
  58.  FLIX command syntax and command line options
  59.  
  60.  
  61.      FLIX [filespec] | options |
  62.  
  63.  Where:
  64.  
  65.      filespec is any valid DOS partial or full file name
  66.  
  67.      The usual DOS file specification characters like '*' and '?'
  68.      are allowed. Omitting filespec defaults to the current
  69.      sub-directory.
  70.  
  71.      options can be any of the following:
  72.  
  73.      /q             - Do not display that annoying initial
  74.                       copyright screen.
  75.  
  76.      /h[help_file]  - Use the help file specified instead of the
  77.                       one pointed to by the FLIX or PATH environment
  78.                       variables.
  79.  
  80.      /p[profile]    - Use the profile file specified instead of the
  81.                       one pointed to by the FLIX or PATH environment
  82.                       variables.
  83. .x
  84.  
  85. .**********************************************************************
  86. .t Commands
  87. .r Keys Function Profile
  88. .x
  89.  
  90.  FLIX  Commands
  91.  
  92.  All the following commands may be entered at the FLIX command line or
  93.  assigned to a F-Key or macro.
  94.  
  95. ───────────────────────┬───────────────────────────────────────────────────────
  96.                        │
  97.    /                   │ Position Current File at top of display
  98.    /nnn                │ Position File "nnn" at top of display
  99.    /A   [filespec]     │ Append Group "filespec" To File List
  100.    /B                  │ Scroll To Last Page Of File List
  101.    /C                  │ Terminate All File List Levels Immediately
  102.    /F   {name.ext | =} │ Find "name.ext" Or Next Occurance Of Previous Find
  103.    /H                  │ Display The Helpfile
  104.                        │
  105.    /L{- | + | n}       │ Select Previous Level, Next Level Or Level "n"
  106.    /L   [filespec]     │ Create New File List Level Using "filespec"
  107.                        │
  108.    /O   command        │ Do Not Append File Specification To This "command"
  109.    /Q                  │ Terminate Current File List Level Immediately
  110.    /R   [filespec]     │ Read Directory To Create File List Using "filespec"
  111.                        │
  112.    /SA                 │ Sort By file Attributes
  113.    /SD                 │ Sort By Date/Time (D), Name, Group and Extension (A)
  114.    /SE                 │ Sort By Extension, Name And Group (A)
  115.    /SG                 │ Sort By Group, Name And Extension (A)
  116.    /SN                 │ Sort By Name, Group And Extension (A)
  117.    /SS                 │ Sort By Size (D), Name, Group And Extension (A)
  118.    /SX                 │ Sort By File Description
  119.                        │
  120.    /T                  │ Scroll to First Page Of File List
  121.    /X                  │ Execute Command Input Area
  122.                        │
  123.    /W                  │ Toggle the cursor between command line and file
  124.                        │ description. If your screen does not show
  125.                        │ the file descriptions then use this command !
  126.                        │
  127.    /=                  │ Position the cursor on column 1 of the next line
  128.                        │ and insert a '=' there.
  129.                        │
  130.    =                   │ Repeat Last DOS Command
  131.    ?                   │ Recall Last DOS Command
  132.                        │
  133. ───────────────────────┴───────────────────────────────────────────────────────
  134. .x
  135.  
  136. .**********************************************************************
  137. .t Keys
  138. .r Commands Function Profile Tab
  139. .x
  140.  
  141.  FLIX Keyboard interface
  142.  
  143.  The following key sequences may be used to perform a variety of FLIX commands.
  144.  These key sequences work in all the screen areas.
  145.  
  146. ───────────────────────┬───────────────────────────────────────────────────────
  147.                        │
  148.    Tab                 │ Move cursor to the next editable field
  149.    Shift-Tab           │ Move cursor to the previous editable field
  150.                        │
  151.    Home                │ Move cursor to the beginning of current field
  152.    End                 │ Cursor to end of current screen area
  153.    PgUp                │ Display previous page of file list
  154.    PgDn                │ Display next page of file list
  155.    Left                │ Cursor left
  156.    Right               │ Cursor right
  157.                        │
  158.    Ctrl-Home           │ Cursor to first file of current page
  159.    Ctrl-End            │ Erase to end of current screen area
  160.    Ctrl-PgUp           │ Display first page of file list
  161.    Ctrl-PgDn           │ Display last page of file list
  162.    Ctrl-Esc            │ Erase all command input areas
  163.    Ctrl-Right          │ Move to the beginning of the next word
  164.    Ctrl-Left           │ Move to the beginning of the previous word
  165.    Ctrl-Enter          │ Move to the beginning of the next line
  166.                        │
  167.    Up                  │ Cursor up
  168.    Down                │ Cursor down
  169.    Ins                 │ Toggle insert and replace mode
  170.    Del                 │ Delete character
  171.    Esc                 │ Restore field to original contents
  172.    Backspace           │ Rubout character
  173.    Scroll Lock         │ Toggle file list scroll and wrap-around mode
  174.    Enter               │ Execute all commands in this list
  175.                        │
  176. ───────────────────────┴───────────────────────────────────────────────────────
  177.  
  178.  The following key sequences may be used only in the file description area.
  179.  
  180. ───────────────────────┬───────────────────────────────────────────────────────
  181.                        │
  182.    Alt-L               │ Mark a line for copying.
  183.    Alt-Z               │ Mark a line for copying. Used as an alias to Alt-L.
  184.    Alt-C               │ Copy the marked line description to the current
  185.                        │ description.
  186.                        │
  187. ───────────────────────┴───────────────────────────────────────────────────────
  188. .x
  189.  
  190. .**********************************************************************
  191. .t Functions
  192. .r Commands Keys Profile
  193. .x
  194.  
  195.  FLIX command line functions/enhancements
  196.  
  197.  The following command sequences can be used to insert part (or all) of the
  198.  current file specification to the command line.
  199.  
  200. ───────────────────────┬───────────────────────────────────────────────────────
  201.                        │
  202.    //                  │ Insert a single slash at this position
  203.                        │
  204.    /                   │ Insert complete fileid at this position
  205.    /D                  │ Insert "d:" component at this position
  206.    /E                  │ Insert ".ext" component at this position
  207.    /N                  │ Insert "filename" component at this position
  208.    /P                  │ Insert "path" component at this position
  209.                        │
  210.    /O                  │ When put at the beginning of a command it will
  211.                        │ indicate that no path component will be appended
  212.                        │ to the command that follows.
  213.                        │
  214. ───────────────────────┴───────────────────────────────────────────────────────
  215. .x
  216.  
  217. .**********************************************************************
  218. .t Profile
  219. .r Commands Keys Function
  220. .x
  221.  
  222.   FLIX profile commands
  223.  
  224.   The following commands can be used in the FLIX profile file.
  225.  
  226. ───────────────────────┬───────────────────────────────────────────────────────
  227.                        │
  228.    *                   │ Insert a comment line on the profile
  229.    ALTER   a a a ... a │ Define which screen fields can be altered
  230.    ATTR    a a a ... a │ Define display attributes
  231.    CHAR    c c c       │ Define command, concatenation and cursor characters
  232.    DEFINE  k = [n] cmd │ Define function key with display name and command
  233.    EXECUTE command     │ Execute flix or dos command during initialization
  234.    FILEID  dpne        │ Define fileid components
  235.    FIATTR  1 1 1 1     │ Define the file attributes used to select files
  236.    MACRO   k = cmd     │ Define macro (alternate) key with command
  237.    OPTION  opt1 ...    │ Set FLIX options
  238.    SYNONYM alias cmd   │ Define synonym of dos command
  239.                        │
  240. ───────────────────────┴───────────────────────────────────────────────────────
  241. .x
  242.  
  243. .**********************************************************************
  244. .t Screen
  245. .r Commands
  246. .x
  247.  
  248.   FLIX screen fields
  249.  
  250.   These are the fields in the FLIX screen. The TAB key can be used to move
  251.   between the FILE, Command Line, File Data, and File Description areas.
  252.   The Profile command: ALTER controls which fields can be TAB'ed into.
  253.  
  254. ─────────────────────────────────────────────────────────────────────────────────
  255.  Title Area
  256. ─────────────────────────────────────────────────────────────────────────────────
  257.  
  258.  File Selection Group Area
  259.  
  260. ─────────┬──────────────┬──────────────┬─────────────────────────────────────────
  261.          │              │              │
  262.  File    │ Command line │ File data    │ File description
  263.          │              │              │
  264.  Area    │ Area         │ Area         │ Area
  265.          │              │              │
  266.          │              │              │
  267.          │              │              │
  268.          │              │              │
  269.          │              │              │
  270.          │              │              │
  271. ─────────┴──────────────┴──────────────┴─────────────────────────────────────────
  272.  
  273.  F-Key definition display Area
  274.  
  275. ─────────────────────────────────────────────────────────────────────────────────
  276. .x
  277.  
  278. .**********************************************************************
  279. .t Tab
  280. .r Commands Keys
  281. .x
  282.  
  283.   TAB key function description.
  284.  
  285.  
  286.   The TAB key allows you to move the cursor to any editable field in the screen
  287.   and make changes there.
  288.  
  289.   Editable fields are Name, Extension, Attribute, Date, Time and Description.
  290.   Just type in the changes you wish to make and next time you hit the Enter
  291.   key, the changes will be permanent ! The extent of changes can be fully
  292.   controlled from the profile setting of the ALTER command.
  293.  
  294.   Example:
  295.  
  296.     TAB once and you will be put in the Attribute field. Now typing the letters
  297.     A, S, R, or H will set those attributes for that file. Typing the letter
  298.     again will toggle the attribute.
  299.  
  300.     The ESC key will reset the field to it's original contents. Hit the Enter
  301.     key to make the changes permanent. It's that simple !
  302.  
  303.   Shift-Tab will Tab you backwards through the fields.
  304.  
  305.   A 'changed' field has different display attributes for easy viewing.
  306.  
  307.   As you can see, changing the name of a file is as simple as TAB'ing
  308.   to the NAME field and just typing in the new name.
  309.   ───────────────────────────────────────────────────────────────────────────────
  310.  
  311.   The profile command: ALTER, fully controls the changes made to a field
  312.   after you TAB there. ALTER allows:
  313.  
  314.     a. No changes to a field if so desired. You can't TAB to a field that
  315.        does not allow changes.
  316.  
  317.     b. Changes to a field but will prompt the user (if he's sure) when the
  318.        user leaves the field. Good for name and extension fields.
  319.  
  320.     c. Changes to a field but will beep when the user leaves the field.
  321.        Good for the Attribute, date and time fields.
  322.  
  323.     d. Changes to a field with no prompt whatsoever when the user leaves the
  324.        field. Great for the description field.
  325.  
  326.   Note: When you are in the Name field, typing the '.' (period) character
  327.         will TAB you to the Extension field.
  328.  
  329.   FLIX, with the TAB key, gives great power to the experienced DOS user.
  330.  
  331.   Caution is advised !!!
  332. .x
  333.  
  334. .**********************************************************************
  335. .t DOS
  336. .r Commands
  337. .x
  338.  
  339.   Shelling out to DOS from FLIX
  340.  
  341.  
  342.   To shell out to DOS from FLIX, just type DOS on any command line. The
  343.   current command processor (as defined by the COMSPEC environment variable)
  344.   will be invoked.
  345.  
  346.   If the COMSPEC environment variable is not defined then an attempt is
  347.   made to run COMMAND.COM from the root directory. If that fails an error
  348.   message will be displayed.
  349. .x
  350.  
  351. .**********************************************************************
  352. .t /
  353. .r Commands
  354. .x
  355.  Syntax
  356.  
  357.    /
  358.  
  359.  Description
  360.  
  361.    Position current file at top of display.
  362.  
  363.  Comments
  364.  
  365.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  366. .x
  367.  
  368. .**********************************************************************
  369. .t /nnn
  370. .r Commands
  371. .x
  372.  Syntax
  373.  
  374.    /nnn
  375.  
  376.  Description
  377.  
  378.    Position file "nnn" at top of display.
  379.  
  380.  Comments
  381.  
  382.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  383. .x
  384.  
  385. .**********************************************************************
  386. .t /A
  387. .r Commands
  388. .x
  389.  Syntax
  390.  
  391.     /A   [filespec]
  392.  
  393.  Description
  394.  
  395.    Append group "filespec" to current file list.
  396.  
  397.  Comments
  398.  
  399.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  400. .x
  401.  
  402. .**********************************************************************
  403. .t /B
  404. .r Commands
  405. .x
  406.  Syntax
  407.  
  408.    /B
  409.  
  410.  Description
  411.  
  412.    Scroll to last page of file list.
  413.  
  414.  Comments
  415.  
  416.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  417. .x
  418.  
  419. .**********************************************************************
  420. .t /C
  421. .r Commands
  422. .x
  423.  Syntax
  424.  
  425.    /C
  426.  
  427.  Description
  428.  
  429.    Terminate all file list levels and exit from FLIX immediately !
  430.  
  431.  Comments
  432.  
  433.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  434. .x
  435.  
  436. .**********************************************************************
  437. .t /F
  438. .r Commands
  439. .x
  440.  Syntax
  441.  
  442.    /F {name.ext | =}
  443.  
  444.  Description
  445.  
  446.    Find "name.ext" or next occurance of previous find.
  447.  
  448.  Comments
  449.  
  450.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  451. .x
  452.  
  453. .**********************************************************************
  454. .t /H
  455. .r Commands
  456. .x
  457.  Syntax
  458.  
  459.    /H
  460.  
  461.  Description
  462.  
  463.    Invoke Help.
  464.  
  465.  Comments
  466.  
  467.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  468. .x
  469.  
  470. .**********************************************************************
  471. .t /L
  472. .r Commands
  473. .x
  474.  Syntax
  475.  
  476.    /L{- | + | n}
  477.  
  478.  Description
  479.  
  480.    Select Previous Level, Next Level Or Level "n".
  481.  
  482.  
  483.    or
  484.  
  485.  
  486.    /L   [filespec]
  487.  
  488.  Description
  489.  
  490.    Create New File List Level Using "filespec".
  491.  
  492.  Comments
  493.  
  494.    Both forms of the command can be issued from the flix command line
  495.    area or assigned to an F-key or macro.
  496. .x
  497.  
  498. .**********************************************************************
  499. .t /O
  500. .r Commands
  501. .x
  502.  Syntax
  503.  
  504.    /O
  505.  
  506.  Description
  507.  
  508.    Do not append file specification to this "command".
  509.  
  510.  Comments
  511.  
  512.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  513. .x
  514.  
  515. .**********************************************************************
  516. .t /Q
  517. .r Commands
  518. .x
  519.  Syntax
  520.  
  521.    /Q
  522.  
  523.  Description
  524.  
  525.    Terminate current file list level immediately.
  526.  
  527.  Comments
  528.  
  529.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  530. .x
  531.  
  532. .**********************************************************************
  533. .t /R
  534. .r Commands
  535. .x
  536.  Syntax
  537.  
  538.    /R   [filespec]
  539.  
  540.  Description
  541.  
  542.    Read directory to create file list using "filespec". When "filespec"
  543.    is ommited this command becomes a refresh command.
  544.  
  545.  Comments
  546.  
  547.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  548. .x
  549.  
  550. .**********************************************************************
  551. .t /SA
  552. .r Commands /SE /SD /SG /SN /SS /SX
  553. .x
  554.  Syntax
  555.  
  556.    /SA
  557.  
  558.  Description
  559.  
  560.    Sort by Attribute, Date/Time, name, group and extension.
  561.  
  562.  Comments
  563.  
  564.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  565. .x
  566.  
  567. .**********************************************************************
  568. .t /SD
  569. .r Commands /SA /SE /SG /SN /SS /SX
  570. .x
  571.  Syntax
  572.  
  573.    /SD
  574.  
  575.  Description
  576.  
  577.    Sort by Date/Time (d), name, group and extension.
  578.  
  579.  Comments
  580.  
  581.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  582. .x
  583.  
  584. .**********************************************************************
  585. .t /SE
  586. .r Commands /SA /SD /SG /SN /SS /SX
  587. .x
  588.  Syntax
  589.  
  590.    /SE
  591.  
  592.  Description
  593.  
  594.    Sort by extension, name and group.
  595.  
  596.  Comments
  597.  
  598.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  599. .x
  600.  
  601. .**********************************************************************
  602. .t /SG
  603. .r Commands /SA /SD /SE /SN /SS /SX
  604. .x
  605.  Syntax
  606.  
  607.    /SG
  608.  
  609.  Description
  610.  
  611.    Sort by group, name and extension.
  612.  
  613.  Comments
  614.  
  615.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  616. .x
  617.  
  618. .**********************************************************************
  619. .t /SN
  620. .r Commands /SA /SD /SE /SG /SS /SX
  621. .x
  622.  Syntax
  623.  
  624.    /SN
  625.  
  626.  Description
  627.  
  628.    Sort by name, group and extension.
  629.  
  630.  Comments
  631.  
  632.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  633. .x
  634.  
  635. .**********************************************************************
  636. .t /SS
  637. .r Commands /SA /SD /SE /SG /SN /SX
  638. .x
  639.  Syntax
  640.  
  641.    /SS
  642.  
  643.  Description
  644.  
  645.    Sort by size (d), name, group and extension.
  646.  
  647.  Comments
  648.  
  649.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  650. .x
  651.  
  652. .**********************************************************************
  653. .t /SX
  654. .r Commands /SA /SD /SE /SG /SN /SS
  655. .x
  656.  Syntax
  657.  
  658.    /SX
  659.  
  660.  Description
  661.  
  662.    Sort by file description.
  663.  
  664.  Comments
  665.  
  666.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  667. .x
  668.  
  669. .**********************************************************************
  670. .t /T
  671. .r Commands
  672. .x
  673.  Syntax
  674.  
  675.    /T
  676.  
  677.  Description
  678.  
  679.    Scroll to first page of file list.
  680.  
  681.  Comments
  682.  
  683.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  684. .x
  685.  
  686. .**********************************************************************
  687. .t /X
  688. .r Commands
  689. .x
  690.  Syntax
  691.  
  692.    /X
  693.  
  694.  Description
  695.  
  696.    Execute Command Input Area.
  697.  
  698.  Comments
  699.  
  700.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  701. .x
  702.  
  703. .**********************************************************************
  704. .t /W
  705. .r Commands Screen
  706. .x
  707.  Syntax
  708.  
  709.    /W
  710.  
  711.  Description
  712.  
  713.    /W stands for sWitch. This command toggles the cursor between command
  714.    line and file description. If the screen is not wide enough to show
  715.    the file descriptions, then the file stats will be hidden and the
  716.    file descriptions will be shown in their place. /W will then toggle
  717.    between descriptions and file stats.
  718.  
  719.    The OPTION profile command controls whether the file stats or the file
  720.    descriptions will be shown if the screen is not wide enough to show
  721.    both.
  722.  
  723.    One of the most usefull commands when working with file descriptions.
  724.  
  725.    Try it !
  726.  
  727.  Comments
  728.  
  729.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  730. .x
  731.  
  732. .**********************************************************************
  733. .t /=
  734. .r Commands = ?
  735. .x
  736.  Syntax
  737.  
  738.    /=
  739.  
  740.  Description
  741.  
  742.    Position the cursor on column 1 of the next line and insert a '=' there.
  743.  
  744.  Comments
  745.  
  746.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  747.    Most usefull when assigned to a F-Key to easily repeat a command
  748.    on most of the files in the current list. Try this one !
  749.  
  750.    Note: To avoid potential hazardous situations, files that begin
  751.          with '.' will not get the equal sign inserted there !
  752. .x
  753.  
  754. .**********************************************************************
  755. .t =
  756. .r Commands /= ?
  757. .x
  758.  Syntax
  759.  
  760.    =
  761.  
  762.  Description
  763.  
  764.    Repeat last DOS command or command issued from the Command Line Area.
  765.  
  766.  Comments
  767.  
  768.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  769. .x
  770.  
  771. .**********************************************************************
  772. .t ?
  773. .r Commands = /=
  774. .x
  775.  Syntax
  776.  
  777.    ?
  778.  
  779.  Description
  780.  
  781.    Recall last DOS command or command issued from the Command Line Area.
  782.  
  783.  Comments
  784.  
  785.    Issued from the FLIX Command line area or assigned to an F-key or macro.
  786. .x
  787.